home *** CD-ROM | disk | FTP | other *** search
/ By Popular Request 2.0 / By Popular Request 2.0 (Arsenal Computer).ISO / amiga_1 / arexx-10.lha / ARexX-10 / ARexX-10.doc < prev    next >
Text File  |  1995-03-20  |  8KB  |  177 lines
  1. /* ARexX-10 */
  2. This is a program for communicating with the X-10 coprocessor being sold
  3. by Marrick Limited. It provides an ARexx hub through which any number of
  4. other programs may communicate with the interface.
  5.  
  6. Requirements: An Amiga with kickstart revision 2.0 or higher and ARexx.
  7. An X-10 Coprocessor board (see sources, below).
  8. A TW-523 X-10 powerline interface.(see sources, below).
  9.  
  10. Disclaimer:  
  11. Although ARexX-10 has been thoroughly tested, no guarantee is given or 
  12. implied  that  this  program  is  fit for any use. The program and the 
  13. information  within  this  text is provided on an "as is" basis. In no 
  14. event  will  I  be  liable  for  any  direct, indirect, incidental, or 
  15. consequential  damages resulting  from the  use of this program or the 
  16. information presented within this text.
  17.  
  18. Author:
  19.  
  20.         ARexX-10 is Copyright ⌐ 1995 Lyle Hazelwood.
  21.       Lyle Hazelwood
  22.       824 Narcissus Ave.
  23.       Holly Hill, Fl. 32117-3341
  24.  
  25.         Commercial  distribution of ARexX-10 or of a package containing 
  26.       ARexX-10 requires written approval of the author.
  27.  
  28.       ARexX-10 May be distributed publicly,  or in library collections,
  29.       As long as all files remain intact and unmodified.
  30.  
  31. Usage: The program may be run from the workbench, from a shell, or by
  32. dragging it's icon into the WBStartup drawer. It does not open a window or
  33. show any visual interface, But the user may communicate with it through
  34. ARexx. It will open the specified serial port, reset the X-10 interface,
  35. and monitor all X-10 activity. the User can write scripts for specific
  36. controls, and/or use the Remote programs provided to access the interface.
  37. The program may be terminated with the quit.rexx script, provided.
  38.  
  39. Shell/Script startup options: The following options may used when starting
  40. the program by shell or script. The template is given in standard AmigaDOS
  41. format. TEMPLATE=P=PORTNAME/K,D=DEVICE/K,U=UNIT/N,B=BAUD/N,S=BUFFERSIZE/N
  42. Most users will not need to change from the default options unless the
  43. interface is connected to a serial port interface card.
  44.  
  45. Option   Abbrev. Default   Description
  46.  
  47. PORTNAME    P     BSR   Sets the name of the ARexx port for this program.
  48. DEVICE      D     serial.device   Specify the serial device to use.
  49. UNIT        U     0     Specify which unit of the serial device to use.
  50. BAUD        B     1200  Specify the baud rate of the X-10 interface.
  51. BUFFERSIZE  S     255   The size of the serial read buffer.
  52.  
  53. Workbench (Icon) startup options: These options are set by selecting the
  54. ARexX-10 icon and selecting "information" from the workbench icon menu.
  55. If not set, they will assume reasonable defaults.
  56.  
  57. TOOLTYPE    Default
  58.  
  59. PORTNAME    BSR            Set the name of the ARexx port.
  60. DEVICE    serial.device  Specify the device driver to access the interface.
  61. UNIT        0              Specify the unit of the serial device
  62. BAUD        1200           Specify the baud rate for the serial port.
  63. SIZE        256            Specify the read buffer size.
  64. DONOTWAIT               Add this tooltype if running from the WBStartup
  65.                         drawer to allow the startup to continue.
  66.  
  67. Note: Arexx must be running BEFORE ARexX-10 is started, or the program will
  68. post an error and exit.
  69.  
  70. Once running, ARexX-10 will open the serial device, and reset the X-10 
  71. interface. This will cause all the LED's to flash for a second. The 
  72. interface may be accessed with the following ARexx commands. If a program
  73. would like to be informed of X-10 activity, it may register for updates
  74. from the ARexX-10 program.
  75.  
  76. Note: before these commands will work, the user must set the ADDRESS for
  77. their ARexx environment to BSR (unless changed by the above options)
  78. Rexx Commands:
  79.  
  80.  
  81. QUIT     the ARexX-10 program will exit, freeing all resources.
  82. SEND commandstring    will send commandstring to the interface. See the
  83.       X-10 interface docs for details on the available commands. If there
  84.       is some sort of error, the rexx message will return as error.
  85. ADD housecodes      will add or modify the notification of the caller
  86.       to the specified housecodes. housecodes is a number representing 
  87.       which housecodes the caller wishes to be notified of. The lowest bit 
  88.       represents A, You may find this number by adding the following 
  89.       numbers for each housecode you wish to be notified for...
  90.                                              A:     1
  91.                                              B:     2
  92.                                              C:     4
  93.                                              D:     8
  94.                                              E:    16
  95.                                              F:    32
  96.                                              G:    64
  97.                                              H:   128
  98.                                              I:   256
  99.                                              J:   512
  100.                                              K:  1024
  101.                                              L:  2048
  102.                                              M:  4096
  103.                                              N:  8192
  104.                                              O: 16384
  105.                                              P: 32768
  106.            All housecodes may be specified with 65535
  107.       After issuing an ADD command, your program will be sent copies of
  108.       all commands relating to the housecodes you have specified. If the
  109.       program wishes to change it's housecodes for notification, simply
  110.       re send the ADD command with the new housecodes, they will replace
  111.       the previously selected ones. NOTE: you will only receive 
  112.       notifications for OTHER programs or transmissions on the power line.
  113.       You will not receive notifications of your own transmissions.
  114. DEL     Will remove all notification for the caller.
  115.       A program which has called ADD should call DEL on exit, or when
  116.       updates are no longer requested.
  117.  
  118.  
  119. Planned for future release:
  120.   1>  A status report of the On/Off/Dim state of each unit on each 
  121.       housecode. This will allow a newly opened remote to show current 
  122.       status of all units available.
  123.  
  124.   2>  A link module allowing certain X-10 events to trigger ARexx scripts.
  125.       
  126.   3>  Whatever is suggested to me, if I like the idea.
  127.  
  128.   4>  Whatever I am paid sufficiently to create, whether I like it or not!
  129.  
  130.  
  131. If you have any comments, suggestions, or donations, I may be reached at:
  132.          Lyle Hazelwood
  133.          824 Narcissus Ave.
  134.          Holly Hill, Fl. 32117-3341
  135. If you develop any neat applications for this, or create any cool new 
  136. remotes, please consider sending me a copy, and tell me whether or not I 
  137. may distribute them in the next release.
  138.  
  139. Enjoy!      8^)
  140.  
  141. Sources:
  142.  
  143.    Software:
  144.       By Modem:
  145.       Marrick Limited BBS: (407) 322-1429 
  146.       News-Journal Center: (904) 947-NEWS (6397) Amiga Forum
  147.  
  148.       By Public channels:
  149.       Updates will be provided to Fred Fish, Home Automation Systems, and
  150.       to Marrick Limited, for them to distribute as they see fit.
  151.  
  152.       From the Author: I will gladly mail updates to anyone who will send
  153.       a check (Payable in U.S. funds) for $5 to cover my time and postage.
  154.       I will send the current version immediately, and will also send the
  155.       next version when it becomes available.
  156.  
  157.    Hardware:
  158.       The TW-523 Powerline interface
  159.       May be ordered from
  160.          Home Automation Systems (HAS-1135  $29.95 as of March '95)
  161.          151 Kalmus Dr. Ste. L4
  162.          Costa Mesa, CA. 92626
  163.          (800) SMART-HOME  (762-7846)
  164.          (800) FOR-XTEN    (367-9836)
  165.       or from
  166.          Marrick Limited      (TW-523  $30.00 as of March '95)
  167.          P.O. Box 950940
  168.          Lake Mary, Fl. 32795
  169.          (407) 323-4467
  170.       
  171.       The X-10 interface may be ordered from
  172.       Home Automation Systems as HAS-1152 (assembled) $139.95 (as of 3/95)
  173.                                  HAS-1150 (kit)        $69.95 (as of 3/95)
  174.  
  175.       Marrick Limited as         101-002-A-ASM        $134.95  (as of 3/95)
  176.                                  101-002-A-KIT         $59.95  (as of 3/95)
  177.